home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / gtmore32.zip / GTMORE.DOC < prev    next >
Text File  |  1993-03-14  |  11KB  |  245 lines
  1.  
  2.                                  GTMORE 3.2
  3.                                   03-14-93
  4.        ──────────────────────────────────────────────────────────────
  5.                                 What is It?
  6.        ──────────────────────────────────────────────────────────────
  7.          A simple little program that will paginate the output of an
  8.          ASCII or ANSI text file, depending on the selection in the       
  9.          GTUSER.BBS file located in the "GTPATH". GTMORE will display
  10.          24 lines of the selected appropriate text file and then display        
  11.          "Pg. 1 of 5 [Q]uit [P]revious [T]op [ENTER] Next:".  The user
  12.          will then have the option of Quitting the display, Viewing the 
  13.          Previous Page, starting over from the Top of the file, or
  14.          continuing on to the next screen of text.  Version 2.1+ uses
  15.          more of a "browsing" style than the previous versions.  Version
  16.          2.4 and above provides the com routines itself.  There is no 
  17.          more need to use GateWay or Doorway.  If you would like to
  18.          force a pause at any time simply place a ^E () in the text to
  19.          be displayed.  GTMORE will not display this character, but will
  20.          count it as a page break.
  21.  
  22.        ──────────────────────────────────────────────────────────────
  23.                                   Options     
  24.        ──────────────────────────────────────────────────────────────
  25.  
  26.          Command Line Format:
  27.  
  28.    GTMORE [/COMx] [/DC] [/DL] [/NC] [/NP]  <ASCII DOCFILE> [ANSI DOCFILE]
  29.  
  30.  
  31.     /? or /HELP Display a 'Quick Help' listing.
  32.  
  33.           /COMx where 'x' may be either 1 or 2.  If /COM1 is specified
  34.                 *AND* 'LOCAL' is not detected in the GTUSER.BBS file,
  35.                 GTMORE will send the text out the COM Port and monitor
  36.                 Carrier Detect on COM1:.  Likewise if /COM2 is specified,
  37.                 GTMORE will use COM2.
  38.                 If Carrier is lost GTMORE will exit with an ErrorLevel
  39.                 5.  If 'LOCAL' is detected the text will not be sent
  40.                 out the Port and the carrier signal will not be monitored.
  41.                 The /COMx parameter is optional.
  42.  
  43.           /DC   if this option is specified GTMORE will NOT open up  
  44.                 the GT.CNF and look for your configured colors.  Instead
  45.                 the default GTMORE colors will be used for ANSI users.
  46.                 Try both way's, if you don't like either way, blame 
  47.                 me for one set of colors, but remember the second set
  48.                 was your doing.  This is a completely optional parameter.
  49.                 It was basically provided for users of slower systems 
  50.                 that did not want to take the time of opening another
  51.                 file before GTMORE took off.
  52.  
  53.           /DL   if this option is specified GTMORE will NOT open up  
  54.                 the USER.CTL file and look for the users Screen Length.
  55.                 Instead, GTMORE will display 24 lines of text and then
  56.                 pause with the GTMORE prompt.  If the user has selected
  57.                 NO PAUSE from GT, ie. 0 in USER.CTL, GTMORE will display
  58.                 24 lines of text and then pause.  This parameter was  
  59.                 basically provided for users of slower systems that did
  60.                 not want to take the time of opening another file before
  61.                 GTMORE took off.
  62.  
  63.           /NC   if this option is specified GTMORE will NOT clear the
  64.                 screen prior to displaying the selected file.  The
  65.                 default of GTMORE is to clear the screen.  The /NC
  66.                 parameter is optional and a matter of preference.
  67.  
  68.           /NP   if this option is specified GTMORE will NOT pause at
  69.                 the end of the file.  The default of GTMORE is to
  70.                 display the following at the end of the displayed file.
  71.  
  72.                  Pg. 5 of 5 [P]revious [T]op [ENTER] Quit:    
  73.  
  74.                 With /NP the above prompt will NOT be displayed and 
  75.                 the final part of your display may not be viewable
  76.                 to the remote user.  This depends entirely on your 
  77.                 application, and what runs after GTMORE is finished.
  78.                 /NP is also an optional parameter.
  79.  
  80.  
  81. <ASCII DOCFILE> This is the file that will be displayed if 'NOANSI' is
  82.                 detected in the GTUSER.BBS file.  This is the ONLY 
  83.                 parameter that is NOT OPTIONAL.  This parameter must
  84.                 follow ALL command line options.  Without a DOCFILE
  85.                 parameter GTMORE will abort....
  86.  
  87. [ANSI DOCFILE]  This is the file that will be displayed if 'NOANSI' is
  88.                 NOT detected in the GTUSER.BBS file.  This is an optional
  89.                 parameter and MUST follow the ASCII DOCFILE if it is   
  90.                 used.  This parameter should ALWAYS be the LAST option
  91.                 placed on the command line.  If only one DOCFILE parameter
  92.                 is on the command line, that one will be used by default.
  93.  
  94.  
  95.  
  96.        ──────────────────────────────────────────────────────────────
  97.                                  Execution..
  98.        ──────────────────────────────────────────────────────────────
  99.          There are seven command line parameters to worry about.  
  100.          Six of these parameters are optional depending on your usage.
  101.          The only mandatory command line option is the name of the ASCII
  102.          text file you wish to display.  If you would like GTMORE to
  103.          display ANSI to callers that have 'ANSI' selected in the 
  104.          GTUSER.BBS file, the name of this file should follow the ASCII
  105.          text file.  See the above discussion of command line options 
  106.          for a listing of optional and mandatory parameters that can be
  107.          placed on the command line.  If no command line parameters are
  108.          given GTMORE will give a small alert signal and exit with an
  109.          errorlevel 2.
  110.          GTMORE fully expects to find a valid GTPATH environment 
  111.          variable and a valid GTUSER.BBS file contained in it. Without
  112.          these two items, GTMORE will croak, I promise.....  If you
  113.          do not wish to display an ANSI file with GTMORE simply leave
  114.          off that command line parameter.  GTMORE will default to the
  115.          first file argument.
  116.  
  117.          Example Command Line:
  118.  
  119.          1. GTMORE GTMSGHLP.BBS GTMSGHLP.CBS
  120.  
  121.             The above example will NOT send the prompt out the com port.
  122.             However is will display the appropriate text file depending
  123.             on the users ANSI selection in the GTUSER.BBS file....
  124.  
  125.          2. GTMORE /COM2 GTMSGHLP.BBS GTMSGHLP.CBS
  126.  
  127.             This example WILL send the text out the com port unless 'LOCAL'
  128.             is detected in the GTUSER.BBS file.  Carrier will also be  
  129.             monitored.
  130.  
  131.          3. GTMORE /COM2 /NC GTMSGHLP.BBS GTMSGHLP.CBS
  132.  
  133.             This example will NOT clear the screen before the appropriate
  134.             file is displayed but WILL send text out the com port unless
  135.             'LOCAL' is detected in the GTUSER.BBS file.
  136.  
  137.          3. GTMORE /COM2 /NP GTMSGHLP.BBS GTMSGHLP.CBS
  138.  
  139.             This example WILL clear the screen before the appropriate
  140.             file is displayed, WILL send text out the com port unless
  141.             'LOCAL' is detected in the GTUSER.BBS file, but will NOT 
  142.             give the final pause at the end of the displayed file.
  143.  
  144.  
  145.          GTMORE will automatically find the GTPATH environment and 
  146.          the GTUSER.BBS file therein.
  147.  
  148.        ──────────────────────────────────────────────────────────────
  149.                                  Errorlevels
  150.        ──────────────────────────────────────────────────────────────
  151.          There are six possible errorlevels to worry about.  They are
  152.          as follows......   
  153.  
  154.       
  155.                   ERRORLEVEL 0  Entire file was displayed.
  156.                   ERRORLEVEL 1  Partial file displayed (N Selected)
  157.                   ERRORLEVEL 2  Insufficient Parameters
  158.                   ERRORLEVEL 3  GTPATH Environment not set.
  159.                   ERRORLEVEL 4  Cannot Open GTUSER.BBS, GT.CNF, or USER.CTL
  160.                   ERRORLEVEL 5  Requested Display File Not Found   
  161.                   ERRORLEVEL 6  Carrier Loss Detected
  162.  
  163.  
  164.        ──────────────────────────────────────────────────────────────
  165.                              Some Possible Uses
  166.        ──────────────────────────────────────────────────────────────
  167.          Following are some of the bacth file uses that you may find 
  168.          handy to your application.......
  169.  
  170.  
  171.          Following are two Batch Files uses that I recieved from Jerry
  172.          Hook (The Engage BBS).  These can be used in DOS, while the BBS
  173.          is not running, do view various files your BBS may be using.  
  174.          Just run either "BBS" or "CBS" depending on your need....
  175.  
  176.  You type:
  177.   CBS            <--display the files.cbs in the current directory
  178.   BBS            <--display the files.bbs in the current directory
  179.   CBS GTMENU     <--display the GTMENU.CBS in the current dir
  180.   BBS GTMDIR     <--display the GTMDIR.BBS in the current dir
  181.  
  182.    ┌──────────┐
  183.    │ CBS.BAT  │
  184.    └──────────┘
  185.    @echo off
  186.    if %1""=="" goto FILES
  187.    gtmore /NC %1.cbs
  188.    goto END
  189.    :FILES
  190.    gtmore /NC files.cbs
  191.    echo 
  192.    goto END
  193.    :END
  194.  
  195.    ┌──────────┐
  196.    │ BBS.BAT  │
  197.    └──────────┘
  198.    @echo off
  199.    if %1""=="" goto FILES
  200.    gtmore /NC %1.bbs
  201.    goto END
  202.    :FILES
  203.    gtmore /NC files.bbs
  204.    echo:
  205.    :END
  206.  
  207.  
  208.          For a more versatile Batch File that will take input from the 
  209.          command line and display any file for you, you might try.....
  210.  
  211.       SHOW.BAT
  212.           @echo off
  213.           gtmore %1
  214.  
  215.  
  216.          The major application that I wrote the program for however, and
  217.          which is still my primary use is for a Batch File called MH.BAT.
  218.          MH.BAT is set up on the MMENU= line in my SYSOP.BBS.  MH stands
  219.          for Message Help.  Users of my BBS can select MH from the message
  220.          read menu and display a help file.  Here is the batch file that
  221.          does the work......   Note that I am NOT using GATEWAY.             
  222.  
  223.         MH.BAT
  224.           @echo off
  225.           gtmore /com2  c:\gt\gtmsghlp.bbs c:\gt\gtmsghlp.cbs
  226.  
  227.  
  228.        ──────────────────────────────────────────────────────────────
  229.                             Who Is Responsible for This?
  230.        ──────────────────────────────────────────────────────────────
  231.                                  Rob Roesch
  232.                               The HOTware BBS
  233.                          GT Power Net-Node 064/003
  234.                                 Rt 7 Box 566
  235.                             Mocksville, NC 27028
  236.                                704-492-2081
  237.  
  238.           If you start using this utility, and get a chance, let me know 
  239.           what you think of it.  If you don't have any use for it, delete  
  240.           it for your total refund of all the disk space that it was
  241.           occupying.  This program comes with no warranty, no guarantee,
  242.           and no promises.  If it works GREAT, if not let me know and I
  243.           will gladly take a look at it in my spare time <g>.
  244.                                                                 
  245.